home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 096 / condor10.arc / CONDOR.DOC < prev    next >
Text File  |  1987-02-12  |  22KB  |  595 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.             ╔════════════════════════════════════════════════════╗
  21.             ║ CONDOR.COM - Allows use of RBBS doors with PCBoard ║
  22.             ║ Ver 1.0 (C) Copyright 1987 Intermountain Softworks ║
  23.             ║     Please study documentation for proper use      ║
  24.             ╟────────────────────────────────────────────────────╢
  25.             ║ Please share unmodified copies and register yours: ║
  26.             ║    $10 - P. O. Box 2043, Walla Walla, WA 99362     ║
  27.             ╚════════════════════════════════════════════════════╝
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.                               February 12, 1987
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.     Intermountain Softworks is pleased to add a short but useful software
  42.     product to the worldwide PC-standard inventory.   Although CONDOR.COM
  43.     will only interest PCBoard system operators running enhanced versions
  44.     11.7D/E  under license,  we are hopeful that BBS'ers everywhere  will
  45.     find more reasons to enjoy their local systems,  and support them  to
  46.     the fullest.
  47.  
  48.     Written entirely in 8086  assembler,  CONDOR will thoroughly convince
  49.     current  releases of RBBS-PC "doorware"  they're running under  RBBS.
  50.     For  suggested sources of these applications,  refer to our  resource
  51.     list at the end of this document.
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.     CONDOR.DOC - Installation and Use
  61.     
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.     1.0 - Acknowledgements                                              3
  74.  
  75.     1.1 - Limited License                                               3
  76.  
  77.     1.2 - Overview                                                      4
  78.  
  79.     1.3 - Version 1.0 Limitations                                       5
  80.  
  81.     2.0 - Installation                                                  6
  82.  
  83.     2.1 - Possible Errors, Results                                      6
  84.  
  85.     2.2 - Subdirectories                                                7
  86.  
  87.     2.3 - Batch Files                                                   8
  88.  
  89.     3.0 - Resources                                                     9
  90.  
  91.     3.1 - A Note for Door Developers                                    9
  92.  
  93.     3.2 - Epilogue                                                      9
  94.  
  95.     Appendix A - CONDOR Registration Request Form                      10
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.                                     Page 2                                    
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.     CONDOR.DOC - Installation and Use
  121.     
  122.     1.0 - Acknowledgements
  123.  
  124.     PCBoard (C) 1985, 1986 Clark Development Company, Inc. (Murray, UT)
  125.       Who wasn't satisfied with existing choices, and has earned a well-
  126.       deserved commercial following.
  127.  
  128.     RBBS-PC (C) 1983..1986 D. Thomas Mack (Great Falls, VA)
  129.       Who brought a respectable BBS to the PC, almost from scratch, and
  130.       placed it within reach of everyone.
  131.  
  132.     Macro Assembler 4.0 (C) 1984, 1985 Microsoft Corp. (Redmond, WA)
  133.       Bouquets for another superb language product!
  134.  
  135.     PC-Write 2.7 (C) 1986 Quicksoft (Seattle, WA)
  136.       Who helps to make writing source code and documentation a joy.
  137.  
  138.     Turbo Lightning 1.0 (C) 1984 Borland Intl. (Scotts Valley, CA)
  139.       Who ensures the text will be spelled correctly.
  140.  
  141.     Finally,  a  special thank-you to Bob Westcott (Merrimack,  NH),  who
  142.     obviously has expended great time,  energy, and several-hundred pages
  143.     of  QuickBASIC  code  (which,  alas,  we have yet to see)   to  bring
  144.     "doorware"  to BBS'ers everywhere.  We hope that the additional forum
  145.     for his efforts comes as a pleasant surprise!
  146.  
  147.  
  148.     1.1 - Limited License
  149.  
  150.          The CONDOR package,  consisting of CONDOR.COM and this document,
  151.     CONDOR.DOC,   is the exclusive property of  Intermountain  Softworks,
  152.     P.zO. Box 2043, Walla Walla, WA  99362.  The package may also include
  153.     certain non-copyrighted sample data and/or batch files.
  154.  
  155.          Users  are  granted  a  limited  license  to  copy  and   freely
  156.     distribute copies of the CONDOR package,  so long as the  distributed
  157.     copies  are  unmodified,  the copyright notice  is  neither  changed,
  158.     removed,   or  bypassed,   and  that  an  unmodified  copy  of   this
  159.     documentation  accompany  the  package.    The  preferred  method  of
  160.     distribution  is  via one's bulletin board system.   Except  for  the
  161.     actual  cost of disk media,  mailer,  and postage,  or the normal BBS
  162.     subscription fee, if any, such distribution must be without charge.
  163.  
  164.  
  165.          Although  Intermountain Softworks is satisfied that this product
  166.     will perform as represented,  and that due care has been exercised in
  167.     development, CONDOR is offered on an "as-is" basis, without warranty,
  168.     either express or implied.  By use of this product,  the user assumes
  169.     all risk,  to include responsibility for installation consistant with
  170.     examples  included  in  this  document,  and as  promulgated  by  the
  171.     developers of PCBoard.
  172.  
  173.                                     Page 3                                    
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.     CONDOR.DOC - Installation and Use
  181.     
  182.          CONDOR  is distributed under the shareware marketing  tradition,
  183.     on a "try-before-you-buy"  basis.   Users are encouraged to  register
  184.     individual copies for the modest sum of $10 per PCBoard installation.
  185.     Registered users will receive one year's complimentary access to  our
  186.     PCBoard  system for thirty-five minutes per day,  and access  to  all
  187.     operating  "doors."    Registration also entitles  one  to  technical
  188.     support within the scope of CONDOR,  also via our PCBoard system.   A
  189.     registration form is included for your convenience.
  190.  
  191.     1.2 - Overview
  192.  
  193.          The  concept  of a "door to DOS"  within BBS  software  probably
  194.     originated  with  Tom Mack and Jon Martin as part  of  their  RBBS-PC
  195.     development.    Tom writes of "horizontal growth"  and adds that  the
  196.     term "doors"  was coined to eliminate any confusion with  MS-Windows.
  197.     Doors are not even remotely like "Windows"  (tm);  indeed, a  door is
  198.     little  more than an exit from the BBS to a separate application,  on
  199.     the tenuous thread of a DOS batch file.
  200.  
  201.          We  suspect  that  Microsoft never intended batch  files  to  be
  202.     invoked remotely by BBS patrons.   The vehicle, however,  is provided
  203.     with  DOS,   and with careful planning and judicious use  of  support
  204.     utilities, batch files are secure enough.
  205.  
  206.          Our "Condor"  package - sort of an acronym for CONvert DoOR - is
  207.     a  quick-fix  in  the pejorative sense.   In  the  first  place,   it
  208.     shouldn't be necessary.   Any programmer who spends all the time  and
  209.     trouble  to write a door for either PCBoard or RBBS-PC may  captivate
  210.     both  audiences  with little additional effort.   Ideally,   a   door
  211.     configuration screen would ask under which system a user proposes  to
  212.     operate.    Unless  the  door author has some  political  reason  for
  213.     limiting  his product to one system or the other,  the larger  market
  214.     potential  in  building flexible doors makes infinitely  more  sense.
  215.     After all, shareware dollars are not that easy to find!
  216.  
  217.          CONDOR.COM,  a short program coded entirely in 8086 assembler to
  218.     provide speed and minimal overhead,  reads in and parses 95  bytes of
  219.     the PCBOARD.SYS file.   It then writes a "messages"  file in a format
  220.     RBBS-PC doorware expects to find.   This procedure also allows one to
  221.     run  doorware  applications  from any drive or  subdirectory  on  the
  222.     system.    Half  of  the  problem is now  solved,   that  of  passing
  223.     currently-logged-user  data  to  the door.   The other  half  of  the
  224.     problem  is  that doorware also expects to find an  RBBS-PC.DEF  file
  225.     within the current directory.
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.                                     Page 4                                    
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.     CONDOR.DOC - Installation and Use
  241.     
  242.          Two immediate reasons surface; there may be others.  First, some
  243.     of  the  doorware applications display one's system name  on  various
  244.     screens.  RBBS-PC.DEF provides that, limited to seventeen characters.
  245.     Second, if one wishes to walk through a doorware application from the
  246.     local  console,  the Sysop's name in the RBBS-PC.DEF file and in  the
  247.     node record of the messages file must match.  We've included a sample
  248.     messages file with variables set to allow this.   Don't be alarmed if
  249.     "Mike  Davidson"  is temporarily recognized as Sysop by the  doorware
  250.     application.    The variables have absolutely no effect  on  PCBoard.
  251.  
  252.  
  253.          The  result  of  all  this  is  that  use  of  RBBS-PC  doorware
  254.     applications is now possible with PCBoard 11.7D/E,  with a minimum of
  255.     fuss.  The capability may well provide added interest for your users.
  256.     One  of  our  particular  favorites is  BBSLIST  -  a  do-it-yourself
  257.     database  of  BBS profiles,  which allows callers to update  a  local
  258.     list,   or  search and sort to suit.   TRADEWARS,  a   space-merchant
  259.     trading game,  a la  Asimov's Foundation series,  is clearly the most
  260.     popular on our system.
  261.  
  262.     1.3 - Version 1.0 Limitations
  263.  
  264.          Few  independent programmers have access to all of the  hardware
  265.     they might prefer.   Version 1.0  of CONDOR is limited to our present
  266.     capability of online testing.   PCBoard and RBBS-PC are both  capable
  267.     of  supporting  many  more features than we've  implemented  in  this
  268.     version.
  269.  
  270.     CONDOR is limited to a maximum bit rate of 2400.
  271.     CONDOR supports a single node.
  272.  
  273.          There is provision within the exit file,  PCBOARD.SYS,  to  pass
  274.     elapsed  time  (as  a four-byte single-precision  real)   to  a  door
  275.     application.    There is a similar variable within the  RBBS-PC  node
  276.     record (a part of the "messages"  file),  but this does not appear to
  277.     be  implemented  in CPC14.1D.   And,  we could find no evidence  that
  278.     14.1C  doorware  applications  use  time  references  from  the  main
  279.     program.    For  the moment,  time restrictions will have to  be  set
  280.     directly within each door,  or else by limiting the number of turns a
  281.     player may use each session.   Doorware instructions usually  explain
  282.     how to do this.
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.                                     Page 5                                    
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.     CONDOR.DOC - Installation and Use
  301.     
  302.          Several  users  have noted that when in ANSI graphics mode  with
  303.     PCBoard,   upon  exit to a doorware application,  the screen  is  not
  304.     cleared  before being overwritten with doorware text.   We concur  in
  305.     CDC's judgement of leaving something "live" on-screen during the time
  306.     required to load a secondary application.  CONDOR properly passes the
  307.     graphics  flag (actually a word-size variable)  to the  RBBS-PC  node
  308.     record.   If the door doesn't make use of it by sending an ESC[2J  to
  309.     clear  the  ANSI screen,  perhaps Bob will include this in  his  next
  310.     releases.
  311.  
  312.          As  we've  already said,  CONDOR will be unnecessary as soon  as
  313.     doorware runs equally well under both systems.   In the meantime,  if
  314.     we  need to change things to support new releases of doorware,   that
  315.     will be done.  Suggestions are always welcome.
  316.  
  317.  
  318.     2.0 - Installation
  319.  
  320.          CONDOR.COM  installation on your PCBoard system (11.7D/E)  is no
  321.     more difficult than properly configuring a batch file and  installing
  322.     WATCHDOG.    CONDOR's operation (that is,  generation of the  RBBS-PC
  323.     messages file)  may be tested off-line; indeed, even the operation of
  324.     version   14.1C   doorware  applications  may  be  inspected   before
  325.     committing oneself to callers.  We strongly recommend, however,  that
  326.     you arrange to do a walk-through via modem - perhaps with a dedicated
  327.     user - before leaving the system to run itself.
  328.  
  329.     2.1 - Possible Errors, Results
  330.  
  331.          CONDOR.COM  can  and  will generate error messages if  it  can't
  332.     locate command-line filespecs you've supplied, or if your spelling is
  333.     bad.   All messages,  including our copyright slug,  are sent to  the
  334.     standard  error device (local monitor),  not over the modem.   Errors
  335.     result  in  a well-behaved abort to your calling batch file,   not  a
  336.     crash.  The fully-insured may wish to provide an IF EXIST test in the
  337.     line  following the call to CONDOR.   This DOS equivalent of "Are you
  338.     there?"   might  then  invoke BOARD.BAT if  the  expected  files  are
  339.     missing.
  340.  
  341.          Be  warned,  however,  that if the RBBS-PC messages file is  not
  342.     written,  or the doorware application cannot find either MESSAGES  or
  343.     RBBS-PC.DEF,  that unpredictable results will occur.   At worst,  the
  344.     door  will hang;  at best,  your caller will see some  cryptic  error
  345.     messages and an instruction to "Press any key to return to system."
  346.  
  347.          CONDOR.COM  will confirm a successful write of the required RBBS
  348.     data  as "RBBS data written"  which appears within a moment or two of
  349.     the  copyright  box.   Execution then passes to the next line of  the
  350.     calling batch file.
  351.  
  352.  
  353.                                     Page 6                                    
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.     CONDOR.DOC - Installation and Use
  361.     
  362.          This  may  be the proper place to advise that error-trapping  is
  363.     not  a  fully-developed science within doorware.   Indeed,   we  have
  364.     witnessed occasional unrecoverable communications errors,  most often
  365.     when a caller is using a machine that simulates the 8250  UART  chip.
  366.     On such occasions, PCBTRAP.COM will reboot the system in an eyeblink.
  367.     Doorware  fortunately writes a file to the current  directory  called
  368.     ERRORS.DOR, reporting what probably happened, in QB error messages.
  369.  
  370.  
  371.     2.2 - Subdirectories
  372.  
  373.          Users   should   carefully   review   CDC's   instructions   for
  374.     implementation of doors, contained within PCBOARD.DOC.  The following
  375.     paragraphs build on that knowledge.
  376.  
  377.          Assuming CDC's standard model for running one or more main board
  378.     doors (conference doors are also possible),  where subdirectories are
  379.     arranged as shown below, we'll walk you through  installation  of the
  380.     doorware application, BBSLIST.
  381.  
  382.                             Drive C:\  (Root)
  383.                               |
  384.        (Subdirectories)       |
  385.       +-----+------+------+---+--------------+
  386.       |     |      |      |                  |
  387.     Lotus   WP   dBase   etc            C:\PCB (Default)
  388.      Sub   Sub    Sub                        |
  389.                                          BOARD.BAT
  390.                                          PCBOARD.EXE
  391.                                          PCBOARD.DAT
  392.                                          PCBOARD.SYS
  393.                                          REMOTE.SYS
  394.     Note: PCBTRAP.COM is normally        EVENT.SYS
  395.     installed via AUTOEXEC.BAT      ->   PCBTRAP.COM
  396.                                     ->   WATCHDG1.COM
  397.                                     ->   CONDOR.COM
  398.                                     ->   BBSLIST.BAT
  399.                                              |
  400.     (All below would be C:\PCB\+name)        |
  401.        +-------+------------+------------+-------+------------+-------+
  402.        |       |            |            |       |            |       |
  403.        UP     MAIN         GEN          HELP   DOORS         DL1     DL2
  404.        |       |            |            |       |                |
  405.      Files    MSGS         BLT          HLPA    BBSLIST1.BAT     Files
  406.     Uploaded  FSEC         BLTG         thru    BBSLIST.EXE      for
  407.       to      PWRD         BLTxx        HLPZ    BBSLIST.*        Down
  408.      Main     TCAN etc...  DIR          etc...  MESSAGES         Load
  409.      Board    DOORS.DAT    DIRG etc...          RBBS-PC.DEF
  410.                            DOORS
  411.                            DOORSG
  412.  
  413.                                     Page 7                                    
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.     CONDOR.DOC - Installation and Use
  421.     
  422.     2.3 - Batch Files
  423.  
  424.     The contents of C:\PCB\BBSLIST.BAT should be as follows:
  425.  
  426.     echo off
  427.     c:\pcb\watchdg1 on
  428.     c:\pcb\condor pcboard.sys c:\pcb\doors\messages
  429.     cd \
  430.     cd\pcb\doors
  431.     bbslist1.bat
  432.     c:\pcb\watchdg1 on
  433.     cd\pcb
  434.     c:\pcb\board.bat
  435.  
  436.     The contents of C:\PCB\DOORS\BBSLIST1.BAT is as follows:
  437.  
  438.     c:\pcb\watchdg1 off
  439.     bbslist.exe
  440.     c:\pcb\watchdg1 on
  441.     cd \
  442.     c:\pcb\board.bat
  443.  
  444.     Note  our  preferred use of fully-qualified  pathnames.    Some  ill-
  445.     behaved applications have been known to confuse DOS,  which  normally
  446.     remembers  a  batch  file's  subdirectory  and  last  line  executed.
  447.     WATCHDG1  (for COM1)  or WATCHDOG (for COM2)  may be safely  disarmed
  448.     immediately prior to calling the application,  as shown,  since 14.1C
  449.     doorware monitors the communications port for loss of carrier.
  450.  
  451.     WARNING:   CDC's proprietary PCBTRAP.COM should be installed  without
  452.     fail for trapping attempted user breakouts.
  453.  
  454.     Recall  from  CDC's discussion of C:\PCB\MAIN\DOORS.DAT,   that  this
  455.     security  file  requires the ACTUAL filename of  the  door's  primary
  456.     batch  file.    If  your door's controlling  batch  file  were  named
  457.     BBSLIST.BAT, then that is the name that must appear within DOORS.DAT.
  458.  
  459.     Finally, observe CONDOR.COM's command line arguments.  The first file
  460.     specification is the input file,  and ALWAYS calls PCBOARD.SYS.   The
  461.     second  argument  is the output file,  MESSAGES.   If  you  choose  a
  462.     different filename, the name must also be changed within RBBS-PC.DEF.
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.                                     Page 8                                    
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.     CONDOR.DOC - Installation and Use
  481.     
  482.     3.0 - Resources
  483.  
  484.          The four major sources of RBBS-PC doorware are...
  485.  
  486.     415-689-2090 CA Concord
  487.     Jon Martin        4       Home of RBBS-PC West
  488.  
  489.     701-293-5973 ND Fargo
  490.     Loren Jones       4       Fargo PCUG,RBBS beta
  491.  
  492.     603-424-5497 NH Merrimack
  493.     Bob Westcott      4       On-Line adventure,Ham
  494.  
  495.     703-759-5049 VA Great Falls
  496.     703-759-9659 VA Great Falls
  497.     Tom Mack          4       Home of RBBS-PC
  498.  
  499.     3.1 - A Note for Door Developers
  500.  
  501.          PCBoard's exit file, PCBOARD.SYS has been extensively documented
  502.     by David Terry and others.   David's Turbo Pascal (R)  example is the
  503.     standard reference.
  504.  
  505.          The  following PCBoard system maintains a private conference  on
  506.     the  subject  of  doors.   A   restricted-distribution  door  kit  is
  507.     available to PCBoard licensees.
  508.  
  509.     201-729-7410 NJ Lake Mohawk
  510.     Paul Kopit      B    4       Software Soc'ty,140M
  511.  
  512.     3.2 - Epilogue
  513.  
  514.          Sadly,   we have paged through BBS messages that  would  suggest
  515.     bitterness  toward  the commercial success of PCBoard.   As  long  as
  516.     computer  programmers  -  professionals and hobbyists  alike  -  have
  517.     imagination,   there  will  always  be  better  ways  of  coding   an
  518.     application.  The result will be more elegant, it will run faster, ad
  519.     infinitum.   It will fix scores of small irritations that should have
  520.     been fixed several releases previously.  It will embrace the smallest
  521.     detail, to include attractive prompts and well-written help.  It will
  522.     be a polished product.
  523.  
  524.          Trip  Hawkins  reminds us (in published advertising)   that  his
  525.     company,  Electronic Arts,  "sees further."   He may well have stated
  526.     the secret of success in this business.
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.                                     Page 9                                    
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.     CONDOR.DOC - Installation and Use
  541.     
  542.     Appendix A - CONDOR Registration Request Form
  543.  
  544.     SEND TO:
  545.  
  546.     Intermountain Softworks
  547.     P. O. Box 2043
  548.     Walla Walla, WA  99362
  549.  
  550.     Quan Item    Price  Total
  551.     [ ]  Diskettes $10:_____________________
  552.     [ ]  Support   $10:_____________________
  553.     Company P.O.  +$ 5:_____________________
  554.     WA orders add 7.9%:_____________________
  555.     TOTAL (US dollars):_____________________
  556.  
  557.     []Check []P.O. []Visa/MC
  558.     Visa/MC #:______________________________
  559.     Exp. Date:______________________________
  560.     Signature:______________________________
  561.  
  562.     SHIP ORDER / USER MAIL / BBS VALIDATION
  563.  
  564.     Name:___________________________________
  565.     Company:________________________________
  566.     Address:________________________________
  567.     City,St,Zip:____________________________
  568.     Business or Data Phone:_________________
  569.     Home Phone:_____________________________
  570.  
  571.     Choice of BBS password:_________________
  572.      (Limit of 12 characters, one word please!)
  573.  
  574.     Registered  users  automatically receive complementary validation  on
  575.     our  PCBoard system,  which operates 24  hours weekends,  and between
  576.     1600h and 0600h Monday through Friday.   On weekdays,  the system  is
  577.     subject to availability after midnight (Pacific).
  578.  
  579.     509/529-7229
  580.  
  581.     No parity, 8 data bits, 1 stop bit
  582.     Bit rates: 2400, 1200, 300
  583.  
  584.     Thank you!
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.                                    Page 10                                    
  594.  
  595.